/*
 * Copyright (c) 2010 Google Inc.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */

package com.google.api.data.gdata.v2.model;

import com.google.api.client.util.DateTime;
import com.google.api.client.util.Key;

import java.util.List;

/**
 * Generic GData Feed.
 * 
 * @author Yaniv Inbar
 * @author Nicolas Garnier
 */
public class Feed {

  @Key
  public String id;

  @Key
  public DateTime updated;

  @Key
  public String title;

  @Key
  public Author author;

  @Key
  public Generator generator;

  @Key("link")
  public List<Link> links;

  @Key("openSearch:totalResults")
  public String totalResult;

  @Key("openSearch:startIndex")
  public String startIndex;

  @Key("openSearch:itemsPerPage")
  public String itemsPerPage;

  /**
   * Returns the self link of the Feed.
   * 
   * @return The self link of the Feed or {@code null} if not found.
   */
  public String getSelfLink() {
    return Link.find(links, "self");
  }

}
